home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / chegvx.z / chegvx
Encoding:
Text File  |  2002-10-03  |  10.2 KB  |  265 lines
  1.  
  2.  
  3.  
  4. CCCCHHHHEEEEGGGGVVVVXXXX((((3333SSSS))))                                                          CCCCHHHHEEEEGGGGVVVVXXXX((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CHEGVX - compute selected eigenvalues, and optionally, eigenvectors of a
  10.      complex generalized Hermitian-definite eigenproblem, of the form
  11.      A*x=(lambda)*B*x, A*Bx=(lambda)*x, or B*A*x=(lambda)*x
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE CHEGVX( ITYPE, JOBZ, RANGE, UPLO, N, A, LDA, B, LDB, VL, VU,
  15.                         IL, IU, ABSTOL, M, W, Z, LDZ, WORK, LWORK, RWORK,
  16.                         IWORK, IFAIL, INFO )
  17.  
  18.          CHARACTER      JOBZ, RANGE, UPLO
  19.  
  20.          INTEGER        IL, INFO, ITYPE, IU, LDA, LDB, LDZ, LWORK, M, N
  21.  
  22.          REAL           ABSTOL, VL, VU
  23.  
  24.          INTEGER        IFAIL( * ), IWORK( * )
  25.  
  26.          REAL           RWORK( * ), W( * )
  27.  
  28.          COMPLEX        A( LDA, * ), B( LDB, * ), WORK( * ), Z( LDZ, * )
  29.  
  30. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  31.      These routines are part of the SCSL Scientific Library and can be loaded
  32.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  33.      directs the linker to use the multi-processor version of the library.
  34.  
  35.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  36.      4 bytes (32 bits). Another version of SCSL is available in which integers
  37.      are 8 bytes (64 bits).  This version allows the user access to larger
  38.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  39.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  40.      only one of the two versions; 4-byte integer and 8-byte integer library
  41.      calls cannot be mixed.
  42.  
  43. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  44.      CHEGVX computes selected eigenvalues, and optionally, eigenvectors of a
  45.      complex generalized Hermitian-definite eigenproblem, of the form
  46.      A*x=(lambda)*B*x, A*Bx=(lambda)*x, or B*A*x=(lambda)*x. Here A and B are
  47.      assumed to be Hermitian and B is also positive definite.  Eigenvalues and
  48.      eigenvectors can be selected by specifying either a range of values or a
  49.      range of indices for the desired eigenvalues.
  50.  
  51.  
  52. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  53.      ITYPE   (input) INTEGER
  54.              Specifies the problem type to be solved:
  55.              = 1:  A*x = (lambda)*B*x
  56.              = 2:  A*B*x = (lambda)*x
  57.              = 3:  B*A*x = (lambda)*x
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCHHHHEEEEGGGGVVVVXXXX((((3333SSSS))))                                                          CCCCHHHHEEEEGGGGVVVVXXXX((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      JOBZ    (input) CHARACTER*1
  75.              = 'N':  Compute eigenvalues only;
  76.              = 'V':  Compute eigenvalues and eigenvectors.
  77.  
  78.      RANGE   (input) CHARACTER*1
  79.              = 'A': all eigenvalues will be found.
  80.              = 'V': all eigenvalues in the half-open interval (VL,VU] will be
  81.              found.  = 'I': the IL-th through IU-th eigenvalues will be found.
  82.  
  83.      UPLO    (input) CHARACTER*1
  84.              = 'U':  Upper triangles of A and B are stored;
  85.              = 'L':  Lower triangles of A and B are stored.
  86.  
  87.      N       (input) INTEGER
  88.              The order of the matrices A and B.  N >= 0.
  89.  
  90.      A       (input/output) COMPLEX array, dimension (LDA, N)
  91.              On entry, the Hermitian matrix A.  If UPLO = 'U', the leading N-
  92.              by-N upper triangular part of A contains the upper triangular
  93.              part of the matrix A.  If UPLO = 'L', the leading N-by-N lower
  94.              triangular part of A contains the lower triangular part of the
  95.              matrix A.
  96.  
  97.              On exit,  the lower triangle (if UPLO='L') or the upper triangle
  98.              (if UPLO='U') of A, including the diagonal, is destroyed.
  99.  
  100.      LDA     (input) INTEGER
  101.              The leading dimension of the array A.  LDA >= max(1,N).
  102.  
  103.      B       (input/output) COMPLEX array, dimension (LDB, N)
  104.              On entry, the Hermitian matrix B.  If UPLO = 'U', the leading N-
  105.              by-N upper triangular part of B contains the upper triangular
  106.              part of the matrix B.  If UPLO = 'L', the leading N-by-N lower
  107.              triangular part of B contains the lower triangular part of the
  108.              matrix B.
  109.  
  110.              On exit, if INFO <= N, the part of B containing the matrix is
  111.              overwritten by the triangular factor U or L from the Cholesky
  112.              factorization B = U**H*U or B = L*L**H.
  113.  
  114.      LDB     (input) INTEGER
  115.              The leading dimension of the array B.  LDB >= max(1,N).
  116.  
  117.      VL      (input) REAL
  118.              VU      (input) REAL If RANGE='V', the lower and upper bounds of
  119.              the interval to be searched for eigenvalues. VL < VU.  Not
  120.              referenced if RANGE = 'A' or 'I'.
  121.  
  122.      IL      (input) INTEGER
  123.              IU      (input) INTEGER If RANGE='I', the indices (in ascending
  124.              order) of the smallest and largest eigenvalues to be returned.  1
  125.              <= IL <= IU <= N, if N > 0; IL = 1 and IU = 0 if N = 0.  Not
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCHHHHEEEEGGGGVVVVXXXX((((3333SSSS))))                                                          CCCCHHHHEEEEGGGGVVVVXXXX((((3333SSSS))))
  137.  
  138.  
  139.  
  140.              referenced if RANGE = 'A' or 'V'.
  141.  
  142.      ABSTOL  (input) REAL
  143.              The absolute error tolerance for the eigenvalues.  An approximate
  144.              eigenvalue is accepted as converged when it is determined to lie
  145.              in an interval [a,b] of width less than or equal to
  146.  
  147.              ABSTOL + EPS *   max( |a|,|b| ) ,
  148.  
  149.              where EPS is the machine precision.  If ABSTOL is less than or
  150.              equal to zero, then  EPS*|T|  will be used in its place, where
  151.              |T| is the 1-norm of the tridiagonal matrix obtained by reducing
  152.              A to tridiagonal form.
  153.  
  154.              Eigenvalues will be computed most accurately when ABSTOL is set
  155.              to twice the underflow threshold 2*SLAMCH('S'), not zero.  If
  156.              this routine returns with INFO>0, indicating that some
  157.              eigenvectors did not converge, try setting ABSTOL to
  158.              2*SLAMCH('S').
  159.  
  160.      M       (output) INTEGER
  161.              The total number of eigenvalues found.  0 <= M <= N.  If RANGE =
  162.              'A', M = N, and if RANGE = 'I', M = IU-IL+1.
  163.  
  164.      W       (output) REAL array, dimension (N)
  165.              The first M elements contain the selected eigenvalues in
  166.              ascending order.
  167.  
  168.      Z       (output) COMPLEX array, dimension (LDZ, max(1,M))
  169.              If JOBZ = 'N', then Z is not referenced.  If JOBZ = 'V', then if
  170.              INFO = 0, the first M columns of Z contain the orthonormal
  171.              eigenvectors of the matrix A corresponding to the selected
  172.              eigenvalues, with the i-th column of Z holding the eigenvector
  173.              associated with W(i).  The eigenvectors are normalized as
  174.              follows:  if ITYPE = 1 or 2, Z**T*B*Z = I; if ITYPE = 3,
  175.              Z**T*inv(B)*Z = I.
  176.  
  177.              If an eigenvector fails to converge, then that column of Z
  178.              contains the latest approximation to the eigenvector, and the
  179.              index of the eigenvector is returned in IFAIL.  Note: the user
  180.              must ensure that at least max(1,M) columns are supplied in the
  181.              array Z; if RANGE = 'V', the exact value of M is not known in
  182.              advance and an upper bound must be used.
  183.  
  184.      LDZ     (input) INTEGER
  185.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  186.              'V', LDZ >= max(1,N).
  187.  
  188.      WORK    (workspace/output) COMPLEX array, dimension (LWORK)
  189.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. CCCCHHHHEEEEGGGGVVVVXXXX((((3333SSSS))))                                                          CCCCHHHHEEEEGGGGVVVVXXXX((((3333SSSS))))
  203.  
  204.  
  205.  
  206.      LWORK   (input) INTEGER
  207.              The length of the array WORK.  LWORK >= max(1,2*N-1).  For
  208.              optimal efficiency, LWORK >= (NB+1)*N, where NB is the blocksize
  209.              for CHETRD returned by ILAENV.
  210.  
  211.              If LWORK = -1, then a workspace query is assumed; the routine
  212.              only calculates the optimal size of the WORK array, returns this
  213.              value as the first entry of the WORK array, and no error message
  214.              related to LWORK is issued by XERBLA.
  215.  
  216.      RWORK   (workspace) REAL array, dimension (7*N)
  217.  
  218.      IWORK   (workspace) INTEGER array, dimension (5*N)
  219.  
  220.      IFAIL   (output) INTEGER array, dimension (N)
  221.              If JOBZ = 'V', then if INFO = 0, the first M elements of IFAIL
  222.              are zero.  If INFO > 0, then IFAIL contains the indices of the
  223.              eigenvectors that failed to converge.  If JOBZ = 'N', then IFAIL
  224.              is not referenced.
  225.  
  226.      INFO    (output) INTEGER
  227.              = 0:  successful exit
  228.              < 0:  if INFO = -i, the i-th argument had an illegal value
  229.              > 0:  CPOTRF or CHEEVX returned an error code:
  230.              <= N:  if INFO = i, CHEEVX failed to converge; i eigenvectors
  231.              failed to converge.  Their indices are stored in array IFAIL.  >
  232.              N:   if INFO = N + i, for 1 <= i <= N, then the leading minor of
  233.              order i of B is not positive definite.  The factorization of B
  234.              could not be completed and no eigenvalues or eigenvectors were
  235.              computed.
  236.  
  237. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  238.      Based on contributions by
  239.         Mark Fahey, Department of Mathematics, Univ. of Kentucky, USA
  240.  
  241.  
  242. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  243.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  244.  
  245.      This man page is available only online.
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.